📝 Fix README factual errors and fill documentation gaps - #6
Merged
Conversation
Update test count and main.py LOC, replace the stale Project Structure tree with the post-split frontend/backend layout, reorder Quick Start so Docker leads and login credentials are surfaced up front, add a GenAI Logic section covering the ReAct loop/tools/RAG/prompt caching, add missing env vars and an Auth column to the API table, and translate Roadmap Phase 5 to English.
…try, credential warning
Document GET /admin/prompts/{use_case}/{version} alongside the list endpoint
in both GenAI Logic and the API table, make the reranker-on-vs-off retrieval
count explicit instead of an unexplained "top 4", and flag the seeded admin
password as a demo default to change before real deployment.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan